// 
// Copyright(c) 2009 Syntext, Inc. All Rights Reserved.
// Contact: info@syntext.com, http://www.syntext.com
// 
// This file is part of Syntext Serna XML Editor.
// 
// COMMERCIAL USAGE
// Licensees holding valid Syntext Serna commercial licenses may use this file
// in accordance with the Syntext Serna Commercial License Agreement provided
// with the software, or, alternatively, in accorance with the terms contained
// in a written agreement between you and Syntext, Inc.
// 
// GNU GENERAL PUBLIC LICENSE USAGE
// Alternatively, this file may be used under the terms of the GNU General 
// Public License versions 2.0 or 3.0 as published by the Free Software 
// Foundation and appearing in the file LICENSE.GPL included in the packaging 
// of this file. In addition, as a special exception, Syntext, Inc. gives you
// certain additional rights, which are described in the Syntext, Inc. GPL 
// Exception for Syntext Serna Free Edition, included in the file 
// GPL_EXCEPTION.txt in this package.
// 
// You should have received a copy of appropriate licenses along with this 
// package. If not, see <http://www.syntext.com/legal/>. If you are unsure
// which license is appropriate for your use, please contact the sales 
// department at sales@syntext.com.
// 
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
// 
/*! \file
 */

#ifndef XSLT_SORT_H
#define XSLT_SORT_H

#include "xpath/Expr.h"
#include "xslt/xslt_defs.h"
#include "xslt/impl/Instruction.h"

namespace Xslt {

/*! \brief ForEach
 */
class Sort : public Instruction {
public:
    XSLT_OALLOC(Sort);
    enum Order { ASCENDING, DESCENDING };

    typedef std::list<Sort*>        List;
    typedef List::const_iterator    CIterator;

    Sort(const GroveLib::Element* element,
         const Stylesheet* context, Instruction* p);
    virtual ~Sort() {};
    //!
    Type                type() const {return SORT;}
    //!
    Order               order() const {return order_;}
    //!
    const Xpath::Expr&  selectExpr() const {return *selectExpr_.pointer();}
    //!
    void                dump() const;
protected:
    //!
    bool                allowsChild(Type) const {return false;}
private:
    const COMMON_NS::String        select_;
    Xpath::ExprPtr      selectExpr_;
    const Order         order_;
};

} // namespace Xslt

#endif // XSLT_FOR_EACH_H
